<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 
<html>
    <head>
        <title>video:capture</title>
        <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
        <link rel="stylesheet" href="nbdocs:/net/neilcsmith/praxis/live/help/docs/help.css" type="text/css">
    </head>
    <body>
        <h1>video:capture</h1>
        <p>Video capture support for using webcams, etc. Generally you should use a generic device
            URI (capture://0, capture://1, etc.) which will work cross-platform. The first device is
        index 0 and so on.</p>
        <p>If your input device supports multiple capture sizes or framerates, it is possible to 
            specify these using the URI query string - eg. <code>capture://0?width=640&amp;height=480&amp;framerate=15/1</code>.
            Be aware that the device will fail to open if the requested settings are not supported.
        </p>
        <p>A capture device will not start automatically.  To get it to start when the video root is
            started, use a <code>core:start-trigger</code> attached to the <code>play</code> port.
        </p>
        <h2>Ports</h2>

        <table border="1" cellpadding="5" cellspacing="0">
            <thead>
                <tr>
                    <th>ID</th>
                    <th>Type</th>
                    <th>Direction</th>
                    <th>Values</th>
                    <th>Description</th>
                </tr>
            </thead>
            <tbody>
                <tr>
                    <td><b>out</b></td>
                    <td>video</td>
                    <td>out</td>
                    <td></td>
                    <td>Video output.</td>
                </tr>
                <tr>
                    <td><b>play</b></td>
                    <td>control</td>
                    <td>in</td>
                    <td>any</td>
                    <td>Start capture device.</td>
                </tr>
                <tr>
                    <td><b>stop</b></td>
                    <td>control</td>
                    <td>in</td>
                    <td>any</td>
                    <td>Stop capture device.</td>
                </tr>
            </tbody>
        </table>

        <h2>Controls</h2>

        <table border="1" cellpadding="5" cellspacing="0">
            <thead>
                <tr>
                    <th>ID</th>
                    <th>Type</th>
                    <th>Input</th>
                    <th>Output</th>
                    <th>Default</th>
                    <th>Description</th>
                </tr>
            </thead>
            <tbody>
                <tr>
                    <td><b>device</b></td>
                    <td>property</td>
                    <td>resource</td>
                    <td></td>
                    <td>{}</td>
                    <td>Capture device - see details above.</td>
                </tr>
                <tr>
                    <td><b>play</b></td>
                    <td>action</td>
                    <td></td>
                    <td></td>
                    <td></td>
                    <td>Start capture device.</td>
                </tr>
                <tr>
                    <td><b>stop</b></td>
                    <td>action</td>
                    <td></td>
                    <td></td>
                    <td></td>
                    <td>Stop capture device.</td>
                </tr>
            </tbody>
        </table>

    </body>
</html>
